Class AttachableNode

This component is used in conjunction with AttachableBehaviour and is used to denote a specific child GameObject that an AttachableBehaviour can attach itself to.

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

NetworkBehaviour

AttachableNode

Inherited Members

NetworkBehaviour.NetworkManager

NetworkBehaviour.RpcTarget

NetworkBehaviour.IsLocalPlayer

NetworkBehaviour.IsOwner

NetworkBehaviour.IsServer

NetworkBehaviour.HasAuthority

NetworkBehaviour.IsSessionOwner

NetworkBehaviour.ServerIsHost

NetworkBehaviour.IsClient

NetworkBehaviour.IsHost

NetworkBehaviour.IsOwnedByServer

NetworkBehaviour.IsSpawned

NetworkBehaviour.NetworkObject

NetworkBehaviour.HasNetworkObject

NetworkBehaviour.NetworkObjectId

NetworkBehaviour.NetworkBehaviourId

NetworkBehaviour.GetNetworkBehaviour(ushort)

NetworkBehaviour.OwnerClientId

NetworkBehaviour.OnDeferringDespawn(int)

NetworkBehaviour.OnNetworkPreSpawn(ref NetworkManager)

NetworkBehaviour.OnNetworkSpawn()

NetworkBehaviour.OnNetworkPostSpawn()

NetworkBehaviour.InternalOnNetworkPostSpawn()

NetworkBehaviour.OnNetworkSessionSynchronized()

NetworkBehaviour.InternalOnNetworkSessionSynchronized()

NetworkBehaviour.OnInSceneObjectsSpawned()

NetworkBehaviour.OnNetworkDespawn()

NetworkBehaviour.OnNetworkPreDespawn()

NetworkBehaviour.OnGainedOwnership()

NetworkBehaviour.OnOwnershipChanged(ulong, ulong)

NetworkBehaviour.OnLostOwnership()

NetworkBehaviour.OnNetworkObjectParentChanged(NetworkObject)

NetworkBehaviour.GetNetworkObject(ulong)

NetworkBehaviour.OnSynchronize<T>(ref BufferSerializer<T>)

NetworkBehaviour.OnReanticipate(double)

NetworkBehaviour.m_TargetIdBeingSynchronized

NetworkBehaviour.OnDestroy()

MonoBehaviour.IsInvoking()

MonoBehaviour.CancelInvoke()

MonoBehaviour.Invoke(string, float)

MonoBehaviour.InvokeRepeating(string, float, float)

MonoBehaviour.CancelInvoke(string)

MonoBehaviour.IsInvoking(string)

MonoBehaviour.StartCoroutine(string)

MonoBehaviour.StartCoroutine(string, object)

MonoBehaviour.StartCoroutine(IEnumerator)

MonoBehaviour.StartCoroutine_Auto(IEnumerator)

MonoBehaviour.StopCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(Coroutine)

MonoBehaviour.StopCoroutine(string)

MonoBehaviour.StopAllCoroutines()

MonoBehaviour.print(object)

MonoBehaviour.destroyCancellationToken

MonoBehaviour.useGUILayout

MonoBehaviour.didStart

MonoBehaviour.didAwake

MonoBehaviour.runInEditMode

Behaviour.enabled

Behaviour.isActiveAndEnabled

Component.GetComponent(Type)

Component.GetComponent<T>()

Component.TryGetComponent(Type, out Component)

Component.TryGetComponent<T>(out T)

Component.GetComponent(string)

Component.GetComponentInChildren(Type, bool)

Component.GetComponentInChildren(Type)

Component.GetComponentInChildren<T>(bool)

Component.GetComponentInChildren<T>()

Component.GetComponentsInChildren(Type, bool)

Component.GetComponentsInChildren(Type)

Component.GetComponentsInChildren<T>(bool)

Component.GetComponentsInChildren<T>(bool, List<T>)

Component.GetComponentsInChildren<T>()

Component.GetComponentsInChildren<T>(List<T>)

Component.GetComponentInParent(Type, bool)

Component.GetComponentInParent(Type)

Component.GetComponentInParent<T>(bool)

Component.GetComponentInParent<T>()

Component.GetComponentsInParent(Type, bool)

Component.GetComponentsInParent(Type)

Component.GetComponentsInParent<T>(bool)

Component.GetComponentsInParent<T>(bool, List<T>)

Component.GetComponentsInParent<T>()

Component.GetComponents(Type)

Component.GetComponents(Type, List<Component>)

Component.GetComponents<T>(List<T>)

Component.GetComponents<T>()

Component.GetComponentIndex()

Component.CompareTag(string)

Component.CompareTag(TagHandle)

Component.SendMessageUpwards(string, object, SendMessageOptions)

Component.SendMessageUpwards(string, object)

Component.SendMessageUpwards(string)

Component.SendMessageUpwards(string, SendMessageOptions)

Component.SendMessage(string, object)

Component.SendMessage(string)

Component.SendMessage(string, object, SendMessageOptions)

Component.SendMessage(string, SendMessageOptions)

Component.BroadcastMessage(string, object, SendMessageOptions)

Component.BroadcastMessage(string, object)

Component.BroadcastMessage(string)

Component.BroadcastMessage(string, SendMessageOptions)

Component.transform

Component.gameObject

Component.tag

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.InstantiateAsync<T>(T)

Object.InstantiateAsync<T>(T, Transform)

Object.InstantiateAsync<T>(T, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int)

Object.InstantiateAsync<T>(T, int, Transform)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion, CancellationToken)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, CancellationToken)

Object.InstantiateAsync<T>(T, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, InstantiateParameters, CancellationToken)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Scene)

Object.Instantiate<T>(T, InstantiateParameters)

Object.Instantiate<T>(T, Vector3, Quaternion, InstantiateParameters)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: Global Namespace

Assembly: Unity.Netcode.Runtime.dll

Syntax

public class AttachableNode : NetworkBehaviour

Remarks

Primarily, the AttachableNode can be used as it is or can be extended to perform additional logical operations when something attaches to or detaches from the AttachableNode instance.

Fields

DetachOnDespawn

When enabled, any attached AttachableBehaviours will be automatically detached and re-parented under its original parent.

Declaration

public bool DetachOnDespawn

Field Value

Type	Description
bool

m_AttachedBehaviours

A List<T> of the currently attached AttachableBehaviours.

Declaration

protected readonly List<AttachableBehaviour> m_AttachedBehaviours

Field Value

Type	Description
List<AttachableBehaviour>

Properties

HasAttachments

Returns true if the AttachableNode instance has one or more attached AttachableBehaviour components.

Declaration

public bool HasAttachments { get; }

Property Value

Type	Description
bool

Methods

OnAttached(AttachableBehaviour)

Override this method to be notified when an AttachableBehaviour has attached to this node.

Declaration

protected virtual void OnAttached(AttachableBehaviour attachableBehaviour)

Parameters

Type	Name	Description
AttachableBehaviour	attachableBehaviour	The AttachableBehaviour that has been attached.

OnDetached(AttachableBehaviour)

Override this method to be notified when an AttachableBehaviour has detached from this node.

Declaration

protected virtual void OnDetached(AttachableBehaviour attachableBehaviour)

Parameters

Type	Name	Description
AttachableBehaviour	attachableBehaviour	The AttachableBehaviour that has been detached.

OnNetworkPreDespawn()

Gets called before OnNetworkDespawn() has been invoked for all NetworkBehaviours associated with the currently spawned NetworkObject instance.

Declaration

public override void OnNetworkPreDespawn()

Overrides

NetworkBehaviour.OnNetworkPreDespawn()

Remarks

If the NetworkObject this AttachableNode belongs to is despawned, then any attached AttachableBehaviour will be detached during OnNetworkDespawn.

OnNetworkPreSpawn(ref NetworkManager)

Gets called after the NetworkObject is spawned. No NetworkBehaviours associated with the NetworkObject will have had OnNetworkSpawn() invoked yet. A reference to NetworkManager is passed in as a parameter to determine the context of execution (IsServer or IsClient).

Declaration

protected override void OnNetworkPreSpawn(ref NetworkManager networkManager)

Parameters

Type	Name	Description
NetworkManager	networkManager	a ref to the NetworkManager since this is not yet set on the NetworkBehaviour

Overrides

NetworkBehaviour.OnNetworkPreSpawn(ref NetworkManager)

Remarks

The NetworkBehaviour will not have anything assigned to it at this point in time. Settings like ownership, NetworkBehaviourId, NetworkManager, and most other spawn-related properties will not be set. This can be used to handle things like initializing a NetworkVariable.

OnOwnershipChanged(ulong, ulong)

Invoked on all clients. Override this method to be notified of any ownership changes (even if the instance was neither the previous or newly assigned current owner).

Declaration

protected override void OnOwnershipChanged(ulong previous, ulong current)

Parameters

Type	Name	Description
ulong	previous	the previous owner
ulong	current	the current owner

Overrides

NetworkBehaviour.OnOwnershipChanged(ulong, ulong)

Remarks

When the ownership of an AttachableNode changes, it will find all currently attached AttachableBehaviour components that are registered as being attached to this instance.